180.静态资源配置原理

几乎每个系统都有静态资源，SpringBoot 也做了相应的支持

‍

加载配置

1. 首先，我们之前讲过，SpringBoot 启动时默认会加载所有的自动配置类（xxxAutoConfiguration 开头的类），jar 包名字为 spring-boot-autoconfigure-2.3.4.RELEASE.jar
2. 其中就有 web 相关的自动配置类，例如 DispatchServletAutoConfiguration，HttpEncodingAutoConfiguration.........
3. 主要还有一个类：WebMbcAutoConfiguration，这个就是配置 SpringMVC 的，类定义如下：

@Configuration(proxyBeanMethods = false)
@ConditionalOnWebApplication(type = Type.SERVLET)
@ConditionalOnClass({ Servlet.class, DispatcherServlet.class, WebMvcConfigurer.class })
@ConditionalOnMissingBean(WebMvcConfigurationSupport.class)
@AutoConfigureOrder(Ordered.HIGHEST_PRECEDENCE + 10)
@AutoConfigureAfter({ DispatcherServletAutoConfiguration.class, TaskExecutionAutoConfiguration.class, ValidationAutoConfiguration.class })
public class WebMvcAutoConfiguration {}

‍

内部类

接下来我们看，其给容器中配置了什么内容。我们主要看其有一个内部类：

@Configuration(proxyBeanMethods = false)
@Import(EnableWebMvcConfiguration.class)
@EnableConfigurationProperties({ WebMvcProperties.class, ResourceProperties.class })
@Order(0)
public static class WebMvcAutoConfigurationAdapter implements WebMvcConfigurer {}

‍

• 第 1 行的注解，说明这是一个配置类；

• 第 3 行的注解，这是进行属性绑定的。

  • 首先 WebMvcProperties 类，和配置文件中 spring.mvc 开头的配置进行了绑定
  • ResourceProperties 类，和配置文件中 spring.resources 开头的配置进行了绑定

该内部类只有一个有参构造器，所有参数的值都会从容器中配置（在 SpringBoot 中大部分都是这样，算是一个特性）

public WebMvcAutoConfigurationAdapter(
    ResourceProperties resourceProperties, WebMvcProperties mvcProperties,
    ListableBeanFactory beanFactory, 
    ObjectProvider<HttpMessageConverters> messageConvertersProvider,
    ObjectProvider<ResourceHandlerRegistrationCustomizer> resourceHandlerRegistrationCustomizerProvider,
    ObjectProvider<DispatcherServletPath> dispatcherServletPath,
    ObjectProvider<ServletRegistrationBean<?>> servletRegistrations) {
	this.resourceProperties = resourceProperties;
	this.mvcProperties = mvcProperties;
	this.beanFactory = beanFactory;
	this.messageConvertersProvider = messageConvertersProvider;
	this.resourceHandlerRegistrationCustomizer = resourceHandlerRegistrationCustomizerProvider.getIfAvailable();
	this.dispatcherServletPath = dispatcherServletPath;
	this.servletRegistrations = servletRegistrations;
}

‍ 该方法的参数说明：

• ResourceProperties resourceProperties：获取和 spring.resources 绑定的所有的值的对象
• WebMvcProperties mvcProperties： 获取和 spring.mvc 绑定的所有的值的对象
• ListableBeanFactory beanFactory： Spring 的 beanFactory，相当于是容器
• HttpMessageConverters： 找到所有的 HttpMessageConverters，后面会说
• ResourceHandlerRegistrationCustomizer： 找到资源处理器的自定义器。
• DispatcherServletPath：路径，后续再说
• ServletRegistrationBean：给应用注册 Servlet、Filter.... ‍ 然后剩余的部分，就是一些配置的方法了，例如 configureXXX 开头的方法。比较重要的是 addResourceHandlers 方法，这是配置资源处理的默认规则。

资源处理的默认规则

该方法源码：

@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
    if (!this.resourceProperties.isAddMappings()) {
	logger.debug("Default resource handling disabled");
	return;
    }
    Duration cachePeriod = this.resourceProperties.getCache().getPeriod();
    CacheControl cacheControl = this.resourceProperties.getCache().getCachecontrol().toHttpCacheControl();
    if (!registry.hasMappingForPattern("/webjars/**")) {
	customizeResourceHandlerRegistration(registry.addResourceHandler("/webjars/**")
			.addResourceLocations("classpath:/META-INF/resources/webjars/")
			.setCachePeriod(getSeconds(cachePeriod)).setCacheControl(cacheControl));
    }
    String staticPathPattern = this.mvcProperties.getStaticPathPattern();
    if (!registry.hasMappingForPattern(staticPathPattern)) {
	customizeResourceHandlerRegistration(registry.addResourceHandler(staticPathPattern)
			.addResourceLocations(getResourceLocations(this.resourceProperties.getStaticLocations()))
			.setCachePeriod(getSeconds(cachePeriod)).setCacheControl(cacheControl));
    }
}

‍

静态资源文件

首先，该方法前 3 行先判断有无禁用路径配置，是的话则直接返回，后续的代码都不生效；例如这样配置

spring:
  resources:
    add-mappings: false   # 默认为true，为false则禁用所有静态资源规则

后续的代码，可以看到配置了 webjars 的路径，是 /META-INF/resources/webjars，这也就是为什么我们之前能访问 webjars 里的内容。

还配置了静态资源的路径，方法 getStaticPathPattern 返回的是 /**，getStaticLocations() 方法则返回的是之前定义的如下路径：

• resources
• resources/static
• resources/public
• /META-INF/resources ‍

缓存配置

‍ 除此之外，我们还可以配置静态资源的缓存（秒为单位）

spring:
  resources:
    cache:
      period: 1100

‍ 然后我们访问 JQuery 的文件，并且刷新，能看到控制台的请求头有时间限制：

‍

在配置类中，也有获取缓存的代码，例如第 7 行有个 getCache 方法：

    Duration cachePeriod = this.resourceProperties.getCache().getPeriod();

欢迎页配置

还有一个欢迎页的配置：

@Bean
public WelcomePageHandlerMapping welcomePageHandlerMapping(
    ApplicationContext applicationContext,
    FormattingConversionService mvcConversionService, 
    ResourceUrlProvider mvcResourceUrlProvider) {
	WelcomePageHandlerMapping welcomePageHandlerMapping = new WelcomePageHandlerMapping(
			new TemplateAvailabilityProviders(applicationContext), applicationContext, getWelcomePage(),
			this.mvcProperties.getStaticPathPattern());
	welcomePageHandlerMapping.setInterceptors(getInterceptors(mvcConversionService, mvcResourceUrlProvider));
	welcomePageHandlerMapping.setCorsConfigurations(getCorsConfigurations());
	return welcomePageHandlerMapping;
}

‍ 我们先说说 HandlerMapping，这是 SpringMVC 的核心组件（在 SpringMVC 中的组件介绍 里讲过），相当于处理器映射，保存了每一个 handler 能处理那些请求。

而 WelcomePageHandlerMapping，相当于配置了欢迎页是谁来处理。

然后方法传入了一堆参数，这些都是从容器中获取的；

然后方法里有 new 一个 WelcomePageHandlerMapping 对象：

WelcomePageHandlerMapping(TemplateAvailabilityProviders templateAvailabilityProviders,
		ApplicationContext applicationContext, Optional<Resource> welcomePage, String staticPathPattern) {
	if (welcomePage.isPresent() && "/**".equals(staticPathPattern)) {
		logger.info("Adding welcome page: " + welcomePage.get());
		setRootViewName("forward:index.html");
	}
	else if (welcomeTemplateExists(templateAvailabilityProviders, applicationContext)) {
		logger.info("Adding welcome page template: index");
		setRootViewName("index");
	}
}

‍ 因此，也就是这里配置了 index 首页的默认配置，并且第 3 行，有判断静态资源路径是否 /**；这也就是为什么，我们之前自定义了静态资源访问路径后，首页就不生效了。